[Ingest Manager] Better handling of package installation problems #66541

skh · 2020-05-14T11:35:45Z

Summary

Fixes #65880

Improves error handling in the handler for the /api/ingest_manager/setup route for
- missing package registry
- errors during the installation of pre-built index templates
Fixes installation of pre-built index templates, caused by us not waiting for component templates to be installed before attempting to install dependent index templates.

The latter was most likely caused by changing behavior of elasticsearch.

Reviewers: please also comment if you agree that this should be backported to the 7.8 branch as a bugfix or not.

How to test this

Missing package registry

in kibana.dev.yml, or on the command line, specify a registry with xpack.ingestManager.epm.registryUrl: 'http://localhost:8080' but don't run it
login in to Kibana and watch the network tab in the browser dev console
the call to /api/ingest_manager/setup should return a 502 http response
Kibana outside Ingest Manager should be usable
If you navigate to Ingest Manager, the error box should contain an informative error message
the Kibana log should contain the same error message, and no stack trace

Missing component template

This fix contains two parts: how the error was handled, and why the error occurred in the first place.

To test the improved error handling, trigger the original error by commenting out this line: https://github.com/elastic/kibana/pull/66541/files#diff-51e0df792f23fb0552e1902bf96453e4R24
restart your local elasticsearch, or make sure the index templates and component templates from the base package are not installed
login to Kibana
the call to /api/ingest_manager/setup should return with a 400 http response containing the elasticsearch error message complaining about missing component templates
To test that the installation of pre-built index templates works, revert the change for the previous test
restart your local elasticsearch, or make sure the index templates and component templates from the base package are not installed
login to Kibana
the call to /api/ingest_manager/setup should return with a 200 http response

elasticmachine · 2020-05-14T11:36:57Z

Pinging @elastic/ingest-management (Team:Ingest Management)

nchaulet · 2020-05-18T13:12:53Z

x-pack/plugins/ingest_manager/server/services/epm/elasticsearch/template/install.ts

@@ -20,8 +21,8 @@ export const installTemplates = async (
  // install any pre-built index template assets,
  // atm, this is only the base package's global index templates
  // Install component templates first, as they are used by the index templates
-  installPreBuiltComponentTemplates(pkgName, pkgVersion, callCluster);
-  installPreBuiltTemplates(pkgName, pkgVersion, callCluster);
+  await installPreBuiltComponentTemplates(pkgName, pkgVersion, callCluster);


Can we do this two operation concurently inside a Promise.all

The second depends on the first being completed, so we can't do them concurrently.

nchaulet · 2020-05-18T13:13:18Z

x-pack/plugins/ingest_manager/server/services/epm/elasticsearch/template/install.ts

+  try {
+    return await Promise.all(templateInstallPromises);
+  } catch (e) {
+    throw new Boom(`Error installing prebuilt index templates ${e.message}`, {


Do we want to start to introduce our domain errors and avoid using Boom ?

I would prefer to start with that in changes that don't go into 7.8 to keep the changes smaller.

x-pack/plugins/ingest_manager/server/services/epm/elasticsearch/template/install.ts

ruflin

Tested this locally and works as expected.

skh · 2020-05-18T15:13:03Z

x-pack/plugins/ingest_manager/server/routes/setup/handlers.ts

+      });
+    }
+    logger.error(e.message);
+    logger.error(e.stack);


@neptunian This gives us a stack trace from the handler that's actually pointing at the real location the error occurred. I only added this here for "unknown" errors.

kibanamachine · 2020-05-18T17:18:04Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 9ff1e60

History

💔 Build #48627 failed 0092b2f
💚 Build #48597 succeeded 3b5926a
💚 Build #47909 succeeded 85398b7

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

…astic#66541) * Better handle non-available package registry * Log errors in route handler only * Await installation of prebuilt component templates * Remove leftover import * Remove useless use of await.

…6541) (#66916) * Better handle non-available package registry * Log errors in route handler only * Await installation of prebuilt component templates * Remove leftover import * Remove useless use of await.

…6541) (#66917) * Better handle non-available package registry * Log errors in route handler only * Await installation of prebuilt component templates * Remove leftover import * Remove useless use of await.

* master: (24 commits) [APM] agent config 'profiling_inferred_spans_min_duration' default value is '0ms' but the min value in the field is '1ms' (elastic#66886) [Canvas] Fix flaky custom element functional tests (elastic#65908) Fix IE specific flexbox min-height issue (elastic#66555) [Discover] Unskip doc link functional test (elastic#66884) Index pattern management to Kibana platform (elastic#65026) Warning and link to support matrix for IE11 (elastic#66512) [Reporting] Consolidate Server Type Defs, move some out of Legacy (elastic#66144) [SIEM] [Maps] Fixes Network Map empty tooltip (elastic#66828) [Endpoint] Encode the index of the alert in the id response (elastic#66919) [services/testSubjects] reduce retry usage, add waitForEnabled (elastic#66538) [DOCS] Identifies cloud settings for APM (elastic#66935) [SIEM][CASE] Fix configuration's page user experience (elastic#66029) Resolver: Display node 75% view submenus (elastic#64121) [SIEM] Cases] Capture timeline click and open timeline in case view (elastic#66327) [APM] Lowercase agent names so icons work (elastic#66824) [dev/cli] add support for --no-cache (elastic#66837) [Ingest Manager] Better handling of package installation problems (elastic#66541) [ML] Enhances api docs for modules endpoints (elastic#66738) dont hide errors (elastic#66764) [RFC] Global search API (elastic#64284) ...

Better handle non-available package registry

85398b7

skh self-assigned this May 14, 2020

skh added Ingest Management:alpha1 Group issues for ingest management alpha1 release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v7.8.0 v7.9.0 v8.0.0 labels May 14, 2020

skh mentioned this pull request May 15, 2020

[Ingest Manager] Error handling in server APIs #66688

Closed

18 tasks

skh added 4 commits May 18, 2020 11:58

Merge branch 'master' into 64067-robust-package-installation-ctd

3b5926a

Log errors in route handler only

dcf36dc

Await installation of prebuilt component templates

0092b2f

Remove leftover import

d6b4c49

skh marked this pull request as ready for review May 18, 2020 12:36

skh requested a review from a team May 18, 2020 12:36

nchaulet reviewed May 18, 2020

View reviewed changes

x-pack/plugins/ingest_manager/server/services/epm/elasticsearch/template/install.ts Outdated Show resolved Hide resolved

ruflin approved these changes May 18, 2020

View reviewed changes

Remove useless use of await.

9ff1e60

skh commented May 18, 2020

View reviewed changes

jonathan-buttner mentioned this pull request May 18, 2020

[Endpoint] Use a search query for alert details #66912

Closed

skh merged commit 84e06af into elastic:master May 18, 2020

skh deleted the 64067-robust-package-installation-ctd branch May 18, 2020 17:18

skh mentioned this pull request May 18, 2020

[7.x] [Ingest Manager] Better handling of package installation problems (#66541) #66916

Merged

skh mentioned this pull request May 18, 2020

[7.8] [Ingest Manager] Better handling of package installation problems (#66541) #66917

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Ingest Manager] Better handling of package installation problems #66541

[Ingest Manager] Better handling of package installation problems #66541

skh commented May 14, 2020 •

edited

Loading

elasticmachine commented May 14, 2020

nchaulet May 18, 2020

skh May 18, 2020

nchaulet May 18, 2020

skh May 18, 2020

ruflin left a comment

skh May 18, 2020

kibanamachine commented May 18, 2020

[Ingest Manager] Better handling of package installation problems #66541

[Ingest Manager] Better handling of package installation problems #66541

Conversation

skh commented May 14, 2020 • edited Loading

Summary

How to test this

Missing package registry

Missing component template

elasticmachine commented May 14, 2020

nchaulet May 18, 2020

Choose a reason for hiding this comment

skh May 18, 2020

Choose a reason for hiding this comment

nchaulet May 18, 2020

Choose a reason for hiding this comment

skh May 18, 2020

Choose a reason for hiding this comment

ruflin left a comment

Choose a reason for hiding this comment

skh May 18, 2020

Choose a reason for hiding this comment

kibanamachine commented May 18, 2020

💚 Build Succeeded

History

skh commented May 14, 2020 •

edited

Loading